home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / vfam116.zip / FILEX.DOC < prev    next >
Text File  |  1992-04-29  |  14KB  |  362 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                             FILEX Version 1.14
  26.                  written by Bill Auclair, FidoNet 1:141/545
  27.              Copyright (C) 1990,1991,1992 by XanSoft Development
  28.                             ALL RIGHTS RESERVED
  29.  
  30.  
  31.  
  32.      FILEX Version 1.14             - 1 -
  33.  
  34.  
  35.  
  36.      Disclaimer
  37.      ----------
  38.        FILEX is guaranteed to do nothing more than decrease your hard
  39.        drive space by one files' worth.  The author shall not be held
  40.        liable for any damages resulting from the use or misuse of this
  41.        software program.  You are cautioned to use this program at your
  42.        own risk.
  43.  
  44.  
  45.  
  46.      Description
  47.      -----------
  48.        FILEX is a software program designed to facilitate the maintenance
  49.        of file areas on Bulletin Board systems using a standard FILES.BBS
  50.        style format.  It was designed to be used as a "stand-alone" program
  51.        from DOS, or in conjunction with a parent utility, a file area
  52.        management program called VersaFAM.  Latest versions of both FILEX and
  53.        VersaFAM may be obtained from the author's BBS (FidoNet 1:141/545).
  54.  
  55.        FILEX is used to add new files to file areas.  Easily invoked from
  56.        the DOS command line, it transports specified files to target file
  57.        areas and automagically updates the list file for those areas,
  58.        optionally supplying a description to be used in the list file.
  59.        FILEX can optionally be set up to create a file list in a directory
  60.        other than that where the target files are located.  This functionality
  61.        is convenient when managing file areas located on CD-ROM disks or
  62.        other "read-only" devices.
  63.  
  64.        FILEX fully supports the use of DOS wildcards * and ?, allowing
  65.        for mass additions of files to file areas.  FILEX can also be
  66.        invoked from a batch file, to handle the addition of periodic
  67.        files (FidoNews, nodediffs, etc.) into file areas.
  68.  
  69.        FILEX uses an optional configuration file named FILEX.DAT.  This file
  70.        can be used to exclude additional filenames from update processing, 
  71.        to reduce FILEX screen output during mass updates, to change the name
  72.        of the output file, and other useful functions.  
  73.        
  74.        When invoked, FILEX will look for FILEX.DAT in the directory
  75.        pointed to by the FILEX environmental variable.  If the FILEX variable
  76.        is not defined, FILEX will look for FILEX.DAT in the current directory.
  77.        If no FILEX.DAT file is found, processing continues normally.
  78.  
  79.        The use of DOS wildcards (*) and (?) is NOT supported when using the
  80.        EXCLUDE verb in FILEX.DAT.  A maximum of 256 filenames may be optionally
  81.        excluded from update processing.
  82.  
  83.        The QUIET configuration file verb may be used to disable the display of
  84.        individual filenames during FILEX processing, reducing program execution
  85.        time by 30 to 70 percent.
  86.  
  87.        List file names other than the default FILES.BBS are supported by
  88.        FILEX.  If you wish to output to a list file other than FILES.BBS, 
  89.        simply enter the list file name after the LISTFILE verb in FILEX.DAT.
  90.  
  91.  
  92.  
  93.      FILEX Version 1.14             - 2 -
  94.  
  95.  
  96.  
  97.        FILEX supports the use of macros within file descriptions.  The 
  98.        following description macros are available:
  99.  
  100.          [DATE]    gives current date in MM/DD/YY format.
  101.          [TIME]    gives current time in HH:MM format.
  102.          [YEAR]    gives verbose listing of current year.
  103.          [MONTH]   gives verbose listing of current month.
  104.          [DAY]     gives verbose listing of current day of the week.
  105.          [0]-[127] sets OEC text/background colors
  106.          [B]       enables blinking
  107.  
  108.  
  109.        To solve problems being experienced by some sysops using utilities
  110.        which require the use of the [] bracket characters, FILEX accepts
  111.        alternate use of soft brace {} characters in macros, specifiable in 
  112.        FILEX.DAT.  This will hopefully eliminate problems with FILEX 
  113.        erroneously interpreting anything enclosed in brackets as macro 
  114.        information.
  115.  
  116.  
  117.  
  118.      Text/background color codes 
  119.      ---------------------------
  120.        FILEX support the use of macros representing OEC codes to change the 
  121.        color of file description text.  The key for these macros can be 
  122.        displayed by typing FILEX COLOR at the DOS command line, then pressing 
  123.        ENTER.  Output can also be redirected to a printer or file if needed, 
  124.        using the DOS > redirection symbol.
  125.  
  126.        Inserting a [B] after any macros will cause the text to blink when
  127.        the color codes are interpreted.  Blinking will continue until another
  128.        color code is encountered.
  129.  
  130.  
  131.  
  132.      Installation 
  133.      ------------
  134.        FILEX should ideally be installed in a subdirectory included in
  135.        your DOS PATH statement.  This will ensure that the program can
  136.        be executed no matter which subdirectory you happen to be in.
  137.  
  138.  
  139.  
  140.      FILEX Version 1.14            - 3 -
  141.  
  142.  
  143.  
  144.      Operation 
  145.      ---------
  146.        FILEX accepts the following command line syntax:
  147.  
  148.        -------------------------------------------------------------------
  149.        FILEX [<source path>] [<target path>] [<description>] [<list path>]
  150.        -------------------------------------------------------------------
  151.  
  152.        EXAMPLES
  153.  
  154.        Suppose you have the file PACMAN.ARC in subdirectory
  155.        C:\TEST.  You want to add this file to a file area using
  156.        subdirectory C:\FILE\GAMES, with a suitable description.  The
  157.        command line syntax used for this example is shown below:
  158.  
  159.  
  160.  
  161.        ------------------------------------------------------------------
  162.        FILEX c:\test\pacman.arc c:\file\games PAC_MAN_Arcade_Game
  163.        ------------------------------------------------------------------
  164.        Note the use of underscores between the words in the description.
  165.        Underscores MUST be used, or the description will not be correctly
  166.        interpreted by the FILEX command line parser.
  167.   
  168.        Suppose you've gotten in a bunch of programming files, all with
  169.        .ZIP extensions, that you'd like to transfer to your Programming
  170.        file area.  You don't care about file area descriptions, you'll
  171.        use VersaFAM to fill them in later. You just need them included
  172.        in the list file with a "generic" description.  The command line
  173.        syntax used for this example is shown below:
  174.  
  175.  
  176.  
  177.        ------------------------------------------------------------------
  178.        FILEX c:\test\*.zip c:\file\program
  179.        ------------------------------------------------------------------
  180.        This transfers all files in C:\TEST with a .ZIP extension to
  181.        C:\FILE\PROGRAM, updating C:\FILE\PROGRAM\FILES.BBS.  When a
  182.        description is not supplied on the command line, FILEX defaults
  183.        to a description of "<Description Unavailable>" for all files.
  184.   
  185.        If the directory from which FILEX is invoked and the target
  186.        subdirectory are the same, the target subdirectory need not be
  187.        specified on the command line:
  188.  
  189.  
  190.  
  191.  
  192.      FILEX Version 1.14              - 4 -
  193.  
  194.  
  195.  
  196.        ------------------------------------------------------------------
  197.        FILEX *.arc
  198.        ------------------------------------------------------------------
  199.        will add all files in C:\FILE\MUSIC with an .ARC extension to
  200.        C:\FILE\MUSIC\FILES.BBS, supplying a generic description, if FILEX
  201.        is called from C:\FILE\MUSIC.  If a non-generic description is to
  202.        be supplied to the files in this example, the hyphen (-) character
  203.        should be used as a "placeholder" to indicate that the current and
  204.        target subdirectories are the same:
  205.   
  206.  
  207.  
  208.        ------------------------------------------------------------------
  209.        FILEX *.arc - New_Music_Files
  210.        ------------------------------------------------------------------
  211.        will add all files in C:\FILE\MUSIC with an .ARC extension to
  212.        C:\FILE\MUSIC\FILES.BBS, using the description supplied on the
  213.        command line, if FILEX is called from C:\FILE\MUSIC.
  214.   
  215.  
  216.  
  217.        ------------------------------------------------------------------
  218.        FILEX fnews???.* d:\newsletr FidoNews,_rec'd_[DATE]_at_[TIME]
  219.        ------------------------------------------------------------------
  220.        will add any existing FidoNews files to D:\NEWSLETR\FILES.BBS,
  221.        using macros to insert a date/time stamp corresponding to when
  222.        the file was processed.
  223.  
  224.  
  225.  
  226.        ------------------------------------------------------------------
  227.        FILEX blah.exe c:\newstuff [15][B]New_Files_[3]as_of_[DATE]
  228.        ------------------------------------------------------------------
  229.        will add the file BLAH.EXE to C:\NEWSTUFF\FILES.BBS, with the words
  230.        "New Files" blinking white in the description, and the rest of the
  231.        line shown in non-blinking cyan.
  232.   
  233.  
  234.  
  235.        ------------------------------------------------------------------
  236.        FILEX g:\cdrom\*.* - New_CD-ROM_files c:\cdlists\file1.bbs
  237.        ------------------------------------------------------------------
  238.        will add generic descriptions for all files in the CD-ROM directory 
  239.        G:\CDROM to the list file FILE1.BBS, located in the C:\CDLISTS
  240.        directory.
  241.  
  242.  
  243.  
  244.        When FILEX is run, the first thing it does is check each target
  245.        file against files already contained in the list file for the target
  246.        subdirectory.  If it finds the target file(s) already listed
  247.        in the list file, it does NOT add the target file(s).  If the specified
  248.        list file is not found in the target subdirectory, one is created.
  249.  
  250.  
  251.  
  252.      FILEX Version 1.14            - 5 -
  253.  
  254.  
  255.  
  256.      Environmental variable
  257.      ---------------------- 
  258.        The FILEX environmental variable may be used to point to the FILEX.DAT 
  259.        file.  A typical environmental variable listing is shown below:
  260.  
  261.  
  262.                               set FILEX=c:\utility
  263.  
  264.  
  265.      Non-processable files 
  266.      ---------------------
  267.        Certain file names and extensions are ignored by FILEX when it is
  268.        processing target files.  These filenames include:
  269.  
  270.                            DIR.BBS         COMn
  271.                            DIR.BAK         LPTn
  272.                            FILES.BBS       PRN
  273.                            FILES.BAK       CON
  274.                            FILES.VFM       SCRN
  275.                            FILEX.DAT       NUL
  276.                            FILEX.EXE
  277.   
  278.  
  279.      Revision history 
  280.      ----------------
  281.  
  282.        1/4/90:     Version 1.03
  283.                    First public non-beta release
  284.  
  285.        3/22/90:    Version 1.05
  286.                    Added description macros [DATE],[TIME],[YEAR],[MONTH],
  287.                    [DAY],[0] thru [15] and [B].  Also added support for
  288.                    the FILEX environment variable, and changed FILEX.OPS
  289.                    log file to append, rather than rewrite the log file
  290.                    each time the program is run.
  291.  
  292.        7/4/90:     Version 1.06
  293.                    Fixed bug that caused FILEX to duplicate existing file
  294.                    entries when those entries did not have a file
  295.                    extension.  Changed blank padding between filenames
  296.                    and descriptions from 1 space to 2 spaces, in order to
  297.                    conform with Opus/Maximus norms.  Increased list file
  298.                    read capacity to 1024 lines to conform with VersaFAM
  299.                    file area manager specifications.
  300.  
  301.        11/28/90:   Version 1.07a (beta)
  302.                    Fixed a glitch that was generating "Invalid Command Line"
  303.                    errors for those running 4DOS by replacing the " placeholder
  304.                    character with the hyphen (-) character instead.
  305.  
  306.  
  307.  
  308.  
  309.      FILEX Version 1.14                 - 6 -
  310.  
  311.  
  312.  
  313.        12/5/90:    Version 1.07b (beta)
  314.                    Revised handling of filename string to avoid duplication of
  315.                    FILES.BBS info when processing lowercase filenames.
  316.  
  317.        12/29/90:   Version 1.07c (beta)
  318.                    Added FILEX.DAT configuration file, with EXCLUDE verb, to
  319.                    allow users to specify additional filenames to be excluded
  320.                    from processing.
  321.  
  322.         1/13/91:   Version 1.07d (beta)
  323.                    Added code to configuration file routines to change TAB
  324.                    characters to spaces when encountered.
  325.  
  326.         2/24/91:   Version 1.08
  327.                    Added QUIET configuration file verb and functions.  Added
  328.                    variable listfile name option.  Removed FILEX.OPS log file
  329.                    option.  Added BIOS configuration file verb.  Generally
  330.                    cleaned up code, optimizing for speed.
  331.  
  332.         6/22/91:   Version 1.12
  333.                    Cleaned up some problems experienced with some undocumented
  334.                    beta versions.  Expanded support of OEC text/background 
  335.                    color codes from 15 to 127 color combinations.  Added color
  336.                    code chart subroutine to executable file.  Added 
  337.                    BRACES/BRACKETS configuration verbs to FILEX.DAT 
  338.                    configuration file.  Cut down on code size, squashed a few 
  339.                    bugs and tightened things up.
  340.  
  341.        4/29/92:    Version 1.14
  342.                    Added [list path] parameter to handle output to file lists
  343.                    located in directories other than where target files are
  344.                    located (i.e., CD-ROMS).  Removed support for the BIOS verb
  345.                    in FILEX.DAT-- all FILEX operations are now BIOS-based, to
  346.                    allow redirection to NUL when run internally from VersaFAM. 
  347.  
  348.  
  349.        Please address all comments, criticisms and bug reports to:
  350.  
  351.                               Bill Auclair
  352.                               XanSoft Development Ltd.
  353.                               13-1 Ridge Rd.
  354.                               Naugatuck, CT 06770
  355.                               FidoNet 1:141/545.0
  356.  
  357.        Thanks a lot.  Hope you get as much enjoyment out of this program
  358.        as I got in bringing it to you....
  359.  
  360.        4/29/92
  361.        Bill Auclair
  362.